Skip to content

[DOC] Update CONTRIBUTING [skip ci] #2393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 24, 2018
Merged

[DOC] Update CONTRIBUTING [skip ci] #2393

merged 4 commits into from
Jan 24, 2018

Conversation

emdupre
Copy link
Contributor

@emdupre emdupre commented Jan 22, 2018

Updates the contributing guidelines and linked documentation.

@emdupre emdupre changed the title [DOC, WIP] Update CONTRIBUTING [skip ci] [DOC] Update CONTRIBUTING [skip ci] Jan 23, 2018
Copy link
Member

@effigies effigies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks much improved. The issue label links are off if you view the rendered Markdown on your branch, but I don't see what in the code is causing the issue. Hopefully you know more about this?


If you experience the same bug as one already listed in an open issue, please add any additional information that you have as a comment.

* [![Help Wanted](https://img.shields.io/badge/-help%20wanted-c2e0c6.svg)][link_helpwanted] *These issues contain a task that a member of the team has determined we need additional help with.*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This links to "help wanted", not "help-wanted".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤦‍♀️ Patched with b9a38d1 !

If you feel that you can contribute to one of these issues, we especially encourage you to do so!
Issues that are also labelled as [good-first-issue][link_good_first_issue] are a great place to start if you're looking to make your first contribution.

* [![Enhancement](https://img.shields.io/badge/-enhancement-00FF09.svg)][link_enhancement] *These issues are asking for new features to be added to the project.*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This links to "feature", not "enhancement".

@emdupre
Copy link
Contributor Author

emdupre commented Jan 23, 2018

Agh, thanks for catching those label links ! The commit I just pushed should fix both "help-wanted" and "enhancement" labels (successfully clicked through on my branch's copy).

Copy link
Member

@effigies effigies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple stylistic points. Feel free to ignore or make changes you feel work better than my suggestions.

CONTRIBUTING.md Outdated
**2. [Fork][link_fork] the [Nipype repository][link_nipype] to your profile.**

This is now your own unique copy of Nipype.
Changes here won't effect anyone else's work, so it's a safe space to explore edits to the code!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

effect => affect

case of any troubles: nipy-devel@neuroimaging.scipy.org (we are sharing a
mailing list with the nipy community therefore please add ``[nipype]`` to the
messsage title).
Nipype is maintained by an enthusiastic group of developers, and we're excited to have you join!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might rephrase: "excited for you to join us!"

In case of trouble, we encourage you to post on `NeuroStars <https://neurostars.org>`_ with the `nipype` tag.
NeuroStars.org is a platform similar to StackOverflow but dedicated to neuroinformatics.
You can also post on the nipype developers mailing list: http://mail.python.org/mailman/listinfo/neuroimaging.
We are sharing a mailing list with the nipy community therefore please add ``[nipype]`` to the message title.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This last sentence reads a little awkwardly to me. Perhaps:

"As we are sharing a mailing list with the nipy community, please add ..."



Overview
--------

We're using the `Enthought Traits
<http://code.enthought.com/projects/traits/>`_ package for all of our
We're using the `Traits, formerly known as Enthought Traits
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd parenthesize the "formerly known as Enthought Traits" part, and not include it in the link text.

@effigies
Copy link
Member

This LGTM. @mgxd if you want this in for the release, I don't see any complications.

@mgxd
Copy link
Member

mgxd commented Jan 24, 2018

LGTM, thank you @emdupre

@mgxd mgxd merged commit 9f3bd59 into nipy:master Jan 24, 2018
@emdupre emdupre deleted the contributing-docs branch January 24, 2018 17:27
@effigies effigies added this to the 1.0 milestone Aug 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants